📖 [Docs]: README pages now use the standard module landing-page format#20
📖 [Docs]: README pages now use the standard module landing-page format#20Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR standardizes README.md into a lightweight module landing page (aligned with the Template-PSModule default), shifting detailed usage guidance to PowerShell help and published docs.
Changes:
- Replaced the long-form README content with a brief module description and streamlined sections.
- Kept installation instructions minimal and added a single documentation link.
- Simplified contributing guidance to point users to the issue tracker.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
README.md:12
Install-PSResourceis not available by default in many PowerShell environments (notably Windows PowerShell 5.1), so copy/pasting this block can fail with “The term 'Install-PSResource' is not recognized…”. Consider either switching toInstall-Moduleor documenting a PowerShellGet fallback / PSResourceGet prerequisite so installation instructions work for a broader set of users.
Install-PSResource -Name CasingStyle
Import-Module -Name CasingStyle
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
The
CasingStyleREADME is now a concise landing page that follows the standard PSModule format, so users get a clear path from install to real usage without wading through duplicated command reference.What changed
## Usageshowcase with three realistic examples using the module's exported commands: convert a string between casing styles (ConvertTo-CasingStyle), detect a string's casing style (Get-CasingStyle), and split a string by casing style (Split-CasingStyle).## InstallationonInstall-PSResourceand a## Documentationsection that points to psmodule.io/CasingStyle plusGet-Command/Get-Helpdiscovery using a real command.## Contributingsection (community/contribution flow lives outside the published landing page).Notes
README.mdonly.